{% extends "layout.html" %}
{% set title = 'Overview' %}

{% block body %}
  <h1>Reaction Mechanism Generator Documentation</h1>

  <p>
  <strong>Reaction Mechanism Generator (RMG)</strong> is an automatic chemical reaction mechanism generator
  that constructs kinetic models composed of elementary chemical reaction steps using a general understanding
  of how molecules react.
  </p>

  <p>
  This documentation site if for the newer Python version of RMG called RMG-Py.
  It is developed on GitHub as <a href="https://github.com/ReactionMechanismGenerator/RMG-Py/" title="RMG-Py github project">RMG-Py</a>.
  </p>

  <p>
  <strong>Arkane</strong> is developed and distributed as part of RMG-Py, but can be used as a stand-alone
  application for Thermochemistry, Transition State Theory, and Master Equation chemical kinetics
  calculations.
  </p>

  <p>
  RMG is free, open-source software, and is under active and ongoing development.
  If you are interested in assisting with or guiding its development, please let us know.
  Any issues, concerns, or comments can be posted to our
  <a href="http://www.github.com/ReactionMechanismGenerator/RMG-Py/issues">Github issues page</a>.
  </p>

  <p>
  While you are free to use or modify RMG components as you wish, we would like to
  coordinate with you. Please contact <a href="mailto:whgreen@mit.edu">Professor William H. Green</a>,
  <a href="mailto:r.west@neu.edu">Professor Richard H. West</a>,
  or the <a href="mailto:rmg_dev@mit.edu">The RMG Development Team</a> for further information.
  </p>

  <h2>Quick reference guide:</h2>

    <table class="rmg">
      <thead>
        <tr>
          <th>I want to...</th>
          <th>Resource</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <td>analyze models &amp; search databases</td>
          <td><a href="http://rmg.mit.edu/">RMG website resources</a>  (no download needed)</td>
        </tr>
        <tr>
          <td>create mechanisms automatically</td>
          <td>Download and run RMG, see the <a href="{{ pathto("users/rmg/index") }}">RMG User's Guide</a></td>
        </tr>
        <tr>
          <td>make transition state theory calculations</td>
          <td>Download RMG and run Arkane, see the <a href="{{ pathto("users/arkane/index") }}">Arkane User's Guide</a></td>
        </tr>
        <tr>
          <td>post an issue with RMG</td>
          <td><a href="https://github.com/ReactionMechanismGenerator/RMG-Py/issues">GitHub issues page</a></td>
        </tr>
        <tr>
          <td>contribute to RMG project</td>
          <td><a href="https://github.com/ReactionMechanismGenerator/RMG-Py/wiki">RMG developer's wiki</a></td>
        </tr>
      </tbody>
    </table>

  <h2>Parts of the documentation:</h2>

    <div style="width: 300px; float: left; margin-left: 30px;">
      <p class="biglink"><a class="biglink" href="{{ pathto("users/rmg/index") }}">RMG User's Guide</a><br/>
         <span class="linkdescr">how to get, install, and use RMG-Py</span></p>
      <p class="biglink"><a class="biglink" href="{{ pathto("users/arkane/index") }}">Arkane User's Guide</a><br/>
         <span class="linkdescr">how to get, install, and use Arkane</span></p>
      <p class="biglink"><a class="biglink" href="{{ pathto("theory/index") }}">Theory Guide</a><br/>
         <span class="linkdescr">some of the theory behind RMG</span></p>
      <p class="biglink"><a class="biglink" href="{{ pathto("reference/index") }}">API Reference</a><br/>
         <span class="linkdescr">the RMG source code</span></p>
      <p class="biglink"><a class="biglink" href="{{ pathto("genindex") }}">General Index</a><br/>
         <span class="linkdescr">all functions, classes, terms</span></p>
    </div>
    <div style="clear:both; width:100%">&nbsp;</div>
  
{% endblock %}
